RateLimiter

JS/TS-friendly facade over com.sorinirmies.arrow.resiliencekit.RateLimiter (token bucket).

import { RateLimiter } from "arrow-resilience-kit";

const rl = await RateLimiter.create({ permitsPerSecond: 10, burstCapacity: 20 });
const result = await rl.execute(() => api.request());

Types

Companion

object Companion

Functions

availableTokens

fun availableTokens(): Promise<Double>

Current number of available tokens.

execute

fun <T> execute(block: () -> Promise<T>): Promise<T>

Executes block if a token is available; rejects otherwise.

executeOrFallback

fun <T> executeOrFallback(fallback: () -> Promise<T>, block: () -> Promise<T>): Promise<T>

Executes block, falling back to fallback if no token is available.

reset

fun reset(): Promise<Unit>

Resets the rate limiter to a full bucket and clears statistics.

resetStatistics

fun resetStatistics(): Promise<Unit>

Resets statistics counters (not the available-token balance).

statistics

fun statistics(): Promise<RateLimiterStatistics>

Current statistics snapshot.

tryAcquire

fun tryAcquire(permits: Int): Promise<Boolean>

Tries to acquire permits tokens without executing anything. Resolves true if acquired.

tryExecute

fun <T> tryExecute(block: () -> Promise<T>): Promise<T?>

Executes block only if a token is immediately available, resolving null otherwise.